<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Extended Item Data Prepare-Time Support</title>
<style type="text/css">@import url("file:/C:/JAHT/eclipse/plugins/org.eclipse.platform_3.3.200.v200908070800/book.css");</style>
<style type="text/css">@import url("file:/C:/JAHT/eclipse/configuration/org.eclipse.osgi/bundles/170/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Extended Item Data Prepare-Time Support</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.birt.report.engine.reportitemQuery<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>1.0
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point specifies how the data that the new report item needs should be prepared. In a server environment, the plugin registry uses this extension point registration to discover supported report item extensions.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.reportItem">reportItem</a>)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.reportItem">reportItem</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST reportItem</p>
<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">getAllRows&nbsp;(true | false) </p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>name</b> - name of the extension item, such as "chart" for chart.</li>
<li><b>class</b> - class which implements IReportItemQuery</li>
<li><b>getAllRows</b> - getAllRows only applies when an ExtendedItem does not have a dataset defined, and the ReportItem is sharing data with its container. True means rowSet contains all rows, while false means rowSet contains only one row.</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is a sample usage of the reportItemQUery extension point:

<p>
<pre class="Example"><span class="code SchemaTag">
&lt;extension point=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.engine.reportitemquery&quot;</span><span class="code SchemaTag"> 
name=</span><span class="code SchemaCstring">&quot;chart report query extension&quot;</span><span class="code SchemaTag">&gt;
  &lt;reportItem name=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.chart&quot;</span><span class="code SchemaTag"> class=</span><span class="code SchemaCstring">&quot;org.eclipse.birt.report.chartitem.ChartQuery&quot;</span><span class="code SchemaTag">/&gt;
 &lt;/extension&gt;
 </span></pre>
 <p>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The value of the class attribute must be the fully qualified name of a class that implements <code>org.eclipse.birt.engine.extension.IReportItemQuery</code>. The interface provides the following functions:

<ul>
<li><code>public void setModelObject(ExtendedItemHandle handle)</code> ---- 
 passes the model object to the extension provider. </li>
<li><code>public IBaseQueryDefinition[] getReportQueries(IBaseQueryDefinition parent) throws BirtException;</code> ----
returns report queries that engine uses to prepare data for the extended item.</li>
</ul>
<p>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>Chart as an extended item
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2005 Actuate Corporation. All rights reserved. This program and 
the accompanying materials are made available under the terms of the Eclipse 
Public License v2.0 which accompanies this distribution, and is available at 
http://www.eclipse.org/legal/epl-2.0.html<br><br>

Contributors: Actuate Corporation - initial API and implementation

</p>
</BODY>
</HTML>
